Skip to content

docs: align README/CLAUDE.md/docs-site with 74-tool surface + add Actions concept section#171

Merged
Lykhoyda merged 1 commit into
mainfrom
worktree-docs-audit
May 18, 2026
Merged

docs: align README/CLAUDE.md/docs-site with 74-tool surface + add Actions concept section#171
Lykhoyda merged 1 commit into
mainfrom
worktree-docs-audit

Conversation

@Lykhoyda
Copy link
Copy Markdown
Owner

Summary

Audited every doc against the actual code surface (commands/, agents/, skills/, scripts/cdp-bridge/src/index.ts) and reconciled the inconsistencies. The biggest gap: Actions is a real, implemented concept (4 MCP tools + 2 slash commands + the experience/ engine) but lived only as a brief table on the docs-site. This PR surfaces it as a 5th tool family and adds the deep "why LLM + pragmatic actions" explanation the README and CLAUDE.md were missing.

Inconsistencies fixed

Area Before After
MCP tool count "70+ / 64 / 51 / 38" across pages 74 everywhere (re-audited 2026-05-18 via trackedTool() calls)
Command count "16 / 13 / 8 listed" 17 everywhere
Tool family count 3-4 families 5 (Actions added)
iOS dispatch (architecture.mdx) "agent-device CLI" rn-fast-runner — matches PR #164 / D1219
cdp_interact label "(deprecated)" Not deprecated in source — fixed
Sidebar No Actions page; missing doctor, list-learned-actions, run-action All added

New "Actions" concept content

docs-site/actions/index.mdx expanded with:

  • Why we have actions — the LLM/pragmatic hybrid (3 paragraphs)
  • Composition pattern with a worked prologue example
  • Measured impact — 13 min 55 s interactive walk → ~4 s replay (~210× speedup); 35-story average ~12 min → ~4 min
  • Failure-mode comparison vs pure-script (Detox/Maestro) and pure-LLM
  • Tool surfacecdp_run_action, cdp_repair_action, cdp_record_test_save_as_action, cdp_record_test_* + /list-learned-actions + /run-action
  • Artifact-first protocolrn-tester / rn-debugger agents scan actions before composing new device_* primitives

README.md Actions block tightened to one paragraph + an updated quick-reference table linking out to the deep doc.

CLAUDE.md gains a contributor-facing Actions section under Architecture so future sessions internalise the LLM+pragmatic hybrid design rationale.

Files changed

  • README.md — header counts, MCP Tools table (5 families), Actions block
  • CLAUDE.md — full command listing, refreshed MCP server section (74 tools, 5 families), new Actions section
  • docs-site/astro.config.mjs — description + schema.org counts, sidebar (Actions page + missing commands)
  • docs-site/src/content/docs/actions/index.mdx — deep hybrid concept content
  • docs-site/src/content/docs/architecture.mdx — iOS/Android dispatch split; 74-tool count
  • docs-site/src/content/docs/tools/index.mdx — 74 tools, 5 families, removed cdp_interact deprecated mislabel

Test plan

  • Skim rendered docs-site locally (cd docs-site && npm run dev) — confirm sidebar shows Actions section, command pages render, Actions page reads cleanly top-to-bottom
  • grep -n "70+\|51 MCP\|64 tools\|38 tools\|16 commands\|13 commands" README.md CLAUDE.md docs-site/ returns nothing
  • Cross-check counts: grep -oE "trackedTool\(\s*'[a-z_]+'" scripts/cdp-bridge/src/index.ts | wc -l should equal 74

Out of scope (intentionally)

  • File relocation of action / macro-assert / recorder tool docs out of docs-site/.../tools/cdp/ into their own folders — would invalidate all existing links; labels and overview pages now describe the families correctly without the move.
  • Adding new skill pages for rn-setup / rn-feature-development / using-rn-dev-agent — those .mdx files don't exist yet; that's an authoring task, not an audit task.

🤖 Generated with Claude Code

…ions concept section

Audit reconciled doc claims against the actual code surface (commands/, agents/,
skills/, scripts/cdp-bridge/src/index.ts) and surfaced the Actions concept that
was already implemented but not documented as its own family.

Counts (everything now reads from a single 2026-05-18 audit of trackedTool calls):

- MCP tools: was "70+ / 64 / 51 / 38" depending on page → 74 everywhere
- Commands: was "16 / 13 / 8 listed" → 17 everywhere
- Agents: 5 (unchanged, was correct)

Outdated info fixed:

- docs-site/architecture.mdx implementation table said iOS routes through
  agent-device CLI; reality since PR #164 / D1219 is rn-fast-runner. Per-platform
  dispatch table now matches CLAUDE.md.
- tools/index.mdx labelled cdp_interact as deprecated; the source description in
  index.ts does not, and the tool is the preferred JS-level interaction primitive.
- astro.config.mjs sidebar omitted the Actions page, doctor, list-learned-actions,
  and run-action; all added.

New "Actions" concept content:

- docs-site/actions/index.mdx expanded with Why-hybrid section, composition pattern
  (worked prologue example), measured impact (210x speedup data point), comparison
  vs pure-script / pure-LLM alternatives, full tool surface (4 MCP + 2 commands),
  and the artifact-first protocol.
- README Actions block tightened to one paragraph + updated table linking to the
  deep doc.
- CLAUDE.md gains a contributor-facing Actions section under Architecture so future
  sessions internalise the LLM+pragmatic hybrid rationale.
- MCP Tools table across all three (README / CLAUDE.md / tools/index.mdx) regrouped
  to surface Actions as a 5th family alongside CDP / Device / Testing / Macro-Asserts.

Files changed: README.md, CLAUDE.md, docs-site/astro.config.mjs, docs-site/src/content/docs/actions/index.mdx, docs-site/src/content/docs/architecture.mdx, docs-site/src/content/docs/tools/index.mdx

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@Lykhoyda Lykhoyda merged commit ad37702 into main May 18, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant